.agent/.github: add topology2 agent design guidance#10685
Open
kv2019i wants to merge 1 commit intothesofproject:mainfrom
Open
.agent/.github: add topology2 agent design guidance#10685kv2019i wants to merge 1 commit intothesofproject:mainfrom
kv2019i wants to merge 1 commit intothesofproject:mainfrom
Conversation
kv2019i
requested review from
dbaluta,
lbetlej,
lgirdwood,
mmaka1 and
plbossart
as code owners
Collaborator
Author
|
The path-based rules are not so standardized yet (copilot, antigravity. cursor all have different conventions). I now added copilot once here and a link to .agent/rules (as we already have .agent/rules for SOF). |
Contributor
There was a problem hiding this comment.
Pull request overview
Adds canonical, in-repo guidance for authors/agents working on ALSA Topology v2 sources under tools/topology/topology2, and wires that guidance into both GitHub Copilot instructions and the existing .agent rule system.
Changes:
- Added a new GitHub Copilot instruction file documenting topology2 structure, reuse expectations, ID/routing conventions, platform overrides, and CMake target registration.
- Added a companion
.agentrule to apply the same guidance when working undertools/topology/topology2/**.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
.github/instructions/topology2-design.instructions.md |
New canonical topology2 design guidance for Copilot/agents scoped to tools/topology/topology2/**. |
.agent/rules/topology2_design.md |
Companion .agent rule pointing contributors to the canonical instruction file. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
lgirdwood
reviewed
Apr 13, 2026
Member
lgirdwood
left a comment
lgirdwood
left a comment
There was a problem hiding this comment.
LGTM, but can you resolve copilot opens.
Add a canonical topology2 instruction file under .github/instructions and a matching companion rule under .agent/rules. Document topology v2 structure, reuse expectations, PCM and pipeline ID conventions, routing rules, platform overrides, and target registration guidance for agents working in tools/topology/topology2. Our existing agent rules are in .agent, but github copilot doesn't understand these yet, so add the companion rule. Signed-off-by: Kai Vehmanen <kai.vehmanen@linux.intel.com>
kv2019i
force-pushed
the
202604-tplg2-agent-rules
branch
from
b319bc7 to
cb556ee
Compare
Collaborator
Author
|
V2 pushed:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add a canonical topology2 instruction file under .github/instructions and a matching companion rule under .agent/rules. Document topology v2 structure, reuse expectations, PCM and pipeline ID conventions, routing rules, platform overrides, and target registration guidance for agents working in tools/topology/topology2.
Our existing agent rules are in .agent, but github copilot doesn't understand these yet, so add the companion rule.